<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>spade.DF.DF</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="spade-module.html">Package&nbsp;spade</a> ::
        <a href="spade.DF-module.html">Module&nbsp;DF</a> ::
        Class&nbsp;DF
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="spade.DF.DF-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DF</h1><p class="nomargin-top"><span class="codelink"><a href="spade.DF-pysrc.html#DF">source&nbsp;code</a></span></p>
<pre class="base-tree">
             object --+                    
                      |                    
     threading._Verbose --+                
                          |                
           threading.Thread --+            
                              |            
<a href="spade.MessageReceiver.MessageReceiver-class.html">MessageReceiver.MessageReceiver</a> --+        
                                  |        
                <a href="spade.Agent.AbstractAgent-class.html">Agent.AbstractAgent</a> --+    
                                      |    
                    <a href="spade.Agent.PlatformAgent-class.html">Agent.PlatformAgent</a> --+
                                          |
                                         <strong class="uidshort">DF</strong>
</pre>

<hr />
<p>Directory Facilitator Agent</p>

<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Nested Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-NestedClasses"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="spade.DF.DF.DefaultBehaviour-class.html" class="summary-name">DefaultBehaviour</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="spade.DF.DF.RegisterBehaviour-class.html" class="summary-name">RegisterBehaviour</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="spade.DF.DF.SearchBehaviour-class.html" class="summary-name">SearchBehaviour</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="spade.DF.DF.ModifyBehaviour-class.html" class="summary-name">ModifyBehaviour</a>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.DF.DF-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">node</span>,
        <span class="summary-sig-arg">passw</span>,
        <span class="summary-sig-arg">server</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">localhost</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">5347</span>)</span><br />
      inits an agent with a JID (user@server) and a platform JID 
      (acc.platformserver)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.DF-pysrc.html#DF.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.DF.DF-class.html#_setup" class="summary-sig-name" onclick="show_private();">_setup</a>(<span class="summary-sig-arg">self</span>)</span><br />
      setup agent method.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.DF-pysrc.html#DF._setup">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.Agent.PlatformAgent-class.html">Agent.PlatformAgent</a></code></b> (private):
      <code><a href="spade.Agent.PlatformAgent-class.html#_register" onclick="show_private();">_register</a></code>,
      <code><a href="spade.Agent.PlatformAgent-class.html#_shutdown" onclick="show_private();">_shutdown</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.Agent.AbstractAgent-class.html">Agent.AbstractAgent</a></code></b>:
      <code><a href="spade.Agent.AbstractAgent-class.html#DEBUG">DEBUG</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#WUIController_admin">WUIController_admin</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#WUIController_log">WUIController_log</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#addAddress">addAddress</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#addBehaviour">addBehaviour</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#deregisterService">deregisterService</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#forceKill">forceKill</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getAID">getAID</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getAMS">getAMS</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getDF">getDF</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getDefaultBehaviour">getDefaultBehaviour</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getDomain">getDomain</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getLog">getLog</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getMUC">getMUC</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getName">getName</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getP2PUrl">getP2PUrl</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getPlatformInfo">getPlatformInfo</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getSocialNetwork">getSocialNetwork</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#getSpadePlatformJID">getSpadePlatformJID</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#initiateStream">initiateStream</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#isRunning">isRunning</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#modifyAgent">modifyAgent</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#modifyService">modifyService</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#newContentObject">newContentObject</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#newMessage">newMessage</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#registerLogComponent">registerLogComponent</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#registerService">registerService</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#removeBehaviour">removeBehaviour</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#requestDiscoInfo">requestDiscoInfo</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#run">run</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#runBehaviourOnce">runBehaviourOnce</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#searchAgent">searchAgent</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#searchService">searchService</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#send">send</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#send_p2p">send_p2p</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#setAID">setAID</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#setDebug">setDebug</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#setDebugToFile">setDebugToFile</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#setDebugToScreen">setDebugToScreen</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#setDefaultBehaviour">setDefaultBehaviour</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#stop">stop</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#subscribeToFriend">subscribeToFriend</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#takeDown">takeDown</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#unsubscribeToFriend">unsubscribeToFriend</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.Agent.AbstractAgent-class.html">Agent.AbstractAgent</a></code></b> (private):
      <code><a href="spade.Agent.AbstractAgent-class.html#_jabber_iqCB" onclick="show_private();">_jabber_iqCB</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#_jabber_messageCB" onclick="show_private();">_jabber_messageCB</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#_jabber_presenceCB" onclick="show_private();">_jabber_presenceCB</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#_kill" onclick="show_private();">_kill</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#_other_messageCB" onclick="show_private();">_other_messageCB</a></code>,
      <code><a href="spade.Agent.AbstractAgent-class.html#_sendTo" onclick="show_private();">_sendTo</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.MessageReceiver.MessageReceiver-class.html">MessageReceiver.MessageReceiver</a></code></b>:
      <code><a href="spade.MessageReceiver.MessageReceiver-class.html#postMessage">postMessage</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.MessageReceiver.MessageReceiver-class.html">MessageReceiver.MessageReceiver</a></code></b> (private):
      <code><a href="spade.MessageReceiver.MessageReceiver-class.html#_receive" onclick="show_private();">_receive</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
      <code>__repr__</code>,
      <code>isAlive</code>,
      <code>isDaemon</code>,
      <code>is_alive</code>,
      <code>join</code>,
      <code>setDaemon</code>,
      <code>setName</code>,
      <code>start</code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
      <code>_set_daemon</code>,
      <code>_set_ident</code>
      </p></div>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>threading._Verbose</code></b> (private):
      <code>_note</code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
      <code>daemon</code>,
      <code>ident</code>,
      <code>name</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">node</span>,
        <span class="sig-arg">passw</span>,
        <span class="sig-arg">server</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">localhost</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">port</span>=<span class="sig-default">5347</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.DF-pysrc.html#DF.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>inits an agent with a JID (user@server) and a platform JID 
  (acc.platformserver)</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_setup"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_setup</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.DF-pysrc.html#DF._setup">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>setup agent method. configures the agent must be overridden</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="spade.Agent.AbstractAgent-class.html#_setup" onclick="show_private();">Agent.AbstractAgent._setup</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed May 26 16:26:23 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
